Resource URL: /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/rules/<NAME>

    Overview: This resource exposes a single OneFS network rule.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: View a single network rule.

       URL: GET
            /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/rules/<NAME>

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "rules": {
      "items": {
        "type": "object", 
        "properties": {
          "subnet": {
            "required": true, 
            "type": "string", 
            "description": "Name of the subnet this rule belongs to."
          }, 
          "iface": {
            "required": true, 
            "type": "string", 
            "description": "Interface name the provisioning rule applies to."
          }, 
          "description": {
            "required": true, 
            "type": "string", 
            "description": "Description for the provisioning rule.", 
            "maxLength": 128
          }, 
          "node_type": {
            "enum": [
              "any", 
              "storage", 
              "accelerator", 
              "storage-i", 
              "accelerator-i", 
              "backup-accelerator"
            ], 
            "type": "string", 
            "description": "Node type the provisioning rule applies to.", 
            "required": true
          }, 
          "groupnet": {
            "required": true, 
            "type": "string", 
            "description": "Name of the groupnet this rule belongs to"
          }, 
          "id": {
            "required": true, 
            "type": "string", 
            "description": "Unique rule ID."
          }, 
          "pool": {
            "required": true, 
            "type": "string", 
            "description": "Name of the pool this rule belongs to."
          }, 
          "name": {
            "required": true, 
            "type": "string", 
            "description": "Name of the provisioning rule.", 
            "maxLength": 32
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify a network rule.

       URL: PUT
            /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/rules/<NAME>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "node_type": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "any", 
            "storage", 
            "accelerator", 
            "storage-i", 
            "accelerator-i", 
            "backup-accelerator"
          ], 
          "type": "string", 
          "description": "Node type the provisioning rule applies to."
        }
      ]
    }, 
    "iface": {
      "type": "string", 
      "description": "Interface name the provisioning rule applies to."
    }, 
    "description": {
      "type": "string", 
      "description": "Description for the provisioning rule.", 
      "maxLength": 128
    }, 
    "name": {
      "type": "string", 
      "description": "Name of the provisioning rule.", 
      "maxLength": 32
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete a network rule.

          URL: DELETE
               /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/rules/<NAME>

There are no query arguments for this method.

There is no response body for this method.
